home *** CD-ROM | disk | FTP | other *** search
/ Scene 96 / Scene 96 International Edition (Zyklop Software) (Disc 2) (1997).iso / player / rdosplay / rdosplay.doc < prev    next >
Text File  |  1997-01-17  |  13KB  |  355 lines
  1.    ┬┬──┐ ┬┬──┐ ┌┬──┐ ┌┬──┐ ┬┬──┐ ┌┐    ┌┬──┐ ┌┐  ┬     ┌┬──┐     ┌┐  ┌┬──┐
  2.    ││  │ ││  │ ││  │ ││    ││  │ ││    ││  │ ││  │     ││  │    ─┤│  ││  │
  3.    │├─┬┘ ││  │ ││  │ └┴─┬┐ │├──┘ ││    │├──┤ │├──┘     ││  │     ││  │├──┤
  4.    ││ └┐ ││  │ ││  │    ││ ││    ││    ││  │ ││        ││  │ ┌┐  ││  ││  │
  5.    └┘  └ ┴┴──┘ └┴──┘ └──┴┘ └┘    └┴──┘ └┘  ┴ └┘        └┴──┘ └┘ ─┴┴─ └┴──┘
  6.     ─────────────────────────────────────────────────────────────────────
  7.  
  8.                   Written by Roman Dolejsi (RDOS of DIMENSION)
  9.  
  10.                                 August 27, 1996
  11.                  Last update: September 5, 1996
  12.  
  13.  
  14.        This is the documentation belonging to and explaining the use of
  15.  
  16.                              RDOSPLAY version 0.17e
  17.                    OPL2/OPL3 music module player for MS-DOS
  18.  
  19.  
  20.    TOPICS covered in this document:
  21.  
  22.      DISCLAIMER
  23.          APOLOGIZE
  24.      PURPOSE OF RDOSPLAY
  25.      REQUIREMENTS
  26.          INSTALLATION OF RDOSPLAY
  27.          RDOSPLAY IN ACTION
  28.          PROGRAM KEYS AND DIALOG LINE
  29.          CURRENTLY SUPPORTED MODULE FORMATS
  30.          MODULE GRABBING
  31.          FREQUENTLY ASKED QUESTIONS
  32.          COPYRIGHT
  33.          WHERE TO FIND RDOSPLAY
  34.          THANX
  35.          CONTACTING ME
  36.  
  37.  
  38.  
  39. DISCLAIMER:
  40. -----------
  41.   Although RDOSPLAY has been tested on several systems, I cannot guarantee that
  42. it is bugless. Therefore I do not  take  responsibility for any damage directly
  43. or indirectly caused by RDOSPLAY as a result of known/unknown  errors in it  or
  44. errors caused by its access to your devices.
  45.  
  46.  
  47. APOLOGIZE:
  48. ----------
  49.   Sorry, english is not my  native language. However, I wrote this nice docy in
  50. english without any help. I APOLOGIZE for any mistakes in the document. Take it
  51. easy... Nobody is perfect.. :-)
  52.  
  53.  
  54. PURPOSE OF RDOSPLAY:
  55. --------------------
  56.   RdosPlay is a OPL2/OPL3 music module player for IBM PC  compatible  computers
  57. running MS-DOS operating system. This  means  that  you  can use it for playing
  58. your  favorite  melody  from some music editor, demo or game. It is FIRST known
  59. generic OPL player. I've coded it because of lack of any player of this type in
  60. PC-world.
  61.  
  62.  
  63. REQUIREMENTS:
  64. -------------
  65.   RdosPlay is coded in  pure 286-assembler  with  no 386+ optimalizations. This
  66. means  you  can  use  your  old 286 and Adlib card for background playing while
  67. doing some work. So The only required things  it needs  is  OPL2/3/4 compatible
  68. card (Adlib or higher), 286 or higher and about 192kB of free mem. For  graphic
  69. analyzers you would probably need at least 386-sx (not tested). The other thing
  70. you need is some music module of course :-)
  71.  
  72.  
  73. INSTALLATION OF RDOSPLAY:
  74. -------------------------
  75.  
  76. - first  you have to make some directory on your drive. Then you have to unpack
  77.   there archive file RPLYxyyz.ZIP. Don't forget  to  unpack it WITH directories
  78.   otherwise you would get a pretty nice garbage :-)
  79.   (you probably did all this when you read these lines :-)
  80.  
  81. - RDOSPLAY pack should consist of these files:
  82.  
  83.     RDOSPLAY.EXE - Main file - OPL player
  84.     RDOSPLAY.DOC - Documentation for RdosPlay (this file)
  85.     RDOSPLAY.REV - RDOSPLAY changes/revision history file
  86.     FILE_ID.DIZ  - bbs file_id header
  87.     FILES\*      - music module examples
  88.  
  89. - now you have RdosPlay successfully installed :-)
  90.  
  91.  
  92. RDOSPLAY IN ACTION:
  93. -------------------
  94.   Rdosplay  uses  your  sound  card's  OPL chip  for  producing synthetic music
  95. typical  for  these  chips. For  OPL2 (mono) musics it can also simulate stereo
  96. by  distributing  channels  in left/right speakers. It's not possible with OPL3
  97. musics  which  do  their  own (precise) panning. OPL2 stereo and OPL3 modes are
  98. both possible only on OPL3 chip of course.
  99.   When  producing  music  RdosPlay  also  shows  some  analyzers  to make world
  100. brighter :-). This  can  be  supressed  when  using slow computers or slow OPL2
  101. emulation (GUS users).
  102.  
  103.  
  104. PROGRAM KEYS AND DIALOG LINE:
  105. -----------------------------
  106. While RdosPlay is running, you can use these keys:
  107.   PgUp - increase track of music (for ADL only)
  108.   PgDn - decrease track of music (for ADL only)
  109.  
  110. Dialog line looks as following:
  111.   RDOSPLAY.EXE [/p] [/t] [/l] [/s] <musfile.ext>
  112.  
  113.   options:
  114.     /pXXX:Y - specifies port and type of OPL chip (avoiding autodetection)
  115.               XXX: hexadecimal base port of the chip
  116.                 Y: 1 = OPL2 (Adlib compatible)
  117.                    2 = OPL3 (Yamaha YM262 stereo chip)
  118.                    3 = OPL4 (Yamaha OPL4 stereo chip)
  119.     /tXXX   - specifies track to be played (for ADL format only, 1-118)
  120.     /s      - enables OPL3-stereo for OPL2 musics (omitted with OPL3 musics)
  121.     /lX     - enables LED-meter on LPT port
  122.               X: port number, where:
  123.                  0 = 3BC (EGA's LPT port)
  124.                  1 = 378 (standard LPT1 port)
  125.                  2 = 278 (standard LPT2 port)
  126.  
  127.  
  128. CURRENTLY SUPPORTED MODULE FORMATS:
  129. -----------------------------------
  130.   RdosPlay  now  supports these formats (where are they and how to get them you
  131. can read in another section):
  132.  
  133.   · ADL (Adlib format similar to XMI)
  134.   · AGD (Herad system - DUNE game)              [OPL3]
  135.   · AMD (Amusic tracker packed files)
  136.   · CAL (ShadowLands game)
  137.   · D00 (JCH / Vibrants ver 1, 2 & 4)
  138.   · FXM (Fuxoft AY music chip language)
  139.   · HSC (HSC music composer)
  140.   · LDS (Loudness system - Zeppelin game)
  141.   · LEM (SI system - XMasLemmings game)
  142.   · MUS (First Samurai game)
  143.   · PLX (Palladix system - Logical game)
  144.   · RAD (Reality ADlib tracker)
  145.   · RAW (raw adlib data - Starport demo)
  146.   · SAT (SAdT music composer)
  147.   · SDB (Herad system - DUNE / KGB games)
  148.   · SIG (SI system 2 - DIZZY games)
  149.   · VIB (JO/Vibrants player)
  150.  
  151. RdosPlay also supports some internal file packers. They are:
  152.   · HSQ (mainly with SDB,AGD - Dune game)
  153.   · SQX (mainly with SDB - KGB game)
  154.   · ICE (mainly with CAL - ShadowLands game)
  155.  
  156.  
  157. MODULE GRABBING:
  158. ----------------
  159.  
  160. · ADL
  161.  
  162.    This is  format  used  in  many games. Each  file  can  consist of up to 118
  163. "tracks"  and  every  track  can  contain  separate  music. Default  track  for
  164. RdosPlay is track number 1. Track can be  selected  with parameter /t. RdosPlay
  165. will pack all used tracks so unused tracks won't be in selection field.
  166.  
  167.  
  168. · AMD
  169.  
  170.    This  extension  covers  files from Amusic tracker by Elyssis. There are two
  171. types  of them. Packed and non-packed. RdosPlay currently supports packed files
  172. only.
  173.  
  174.  
  175. · CAL
  176.  
  177.    This  standard  is  used  in  ShadowLands  game.  Look  there  and find file
  178. TUNE.CAL. It's ICE-packed file and RdosPlay has internal ICE-unpacker.
  179.  
  180.  
  181. · D00
  182.  
  183.    These  files  are  for  JCH / Vibrants player. They are created in Vibrant's
  184. editor  named  EdLib by packing standard *.EDL editor's files. Look for them in
  185. intros or in that editor. Files for player ver 2+ begin with 'JCH' sign.
  186.    Example: intro KUKKO2.EXE, offset B2A (module named CROONER.D00).
  187.  
  188.  
  189. · FXM
  190.  
  191.    These  files  are  special blocks of music code used in Fuxoft SoundTrack on
  192. ZX Spectrum computer. This  computer  has  3-channel sound chip named AY3-8910.
  193. RdosPlay  has  FXM interpreter and AY->OPL2 convertor. All the files that exist
  194. in this format are supplied with RdosPlay standard distribution.
  195.  
  196.  
  197. · HSC
  198.  
  199.    HSC files are commonly used in short demos and intros. The source from where
  200. they  came  is  mainly  HSC composer  which  is  available  on  anonymous FTP's
  201. on I-net. There  you  can  get  most of these files (about 100 modules). If you
  202. grab some file its extension must be HSC otherwise RdosPlay won't recognize it!
  203.  
  204.  
  205. · LDS
  206.  
  207.    These files are used in LOUDNESS system. Look  in  ZEPPELIN game's SOUND
  208. directory and take all *.DAT files.
  209.  
  210.  
  211. · LEM
  212.  
  213.    These  files  are  used  in X-Mas Lemmings game. Grab  them  yourself. Their
  214. sign is [0]=1C 52.
  215.  
  216.  
  217. · MUS
  218.  
  219.    This standard is used in FIRST SAMURAI game. Take file ADLIB.MUS.
  220.  
  221.  
  222. · PLX
  223.  
  224.    This standard is used in LOGICAL game. All  music  files  are stored in file
  225. LOGICAL.EXE. You have  to  grab  them  from this file. Here are file positions:
  226. 13310, 165C0, 1B160, 1F320, 50360, 50550, 50730, 50990, 50B90, 50D10, 50FA0,
  227. 510F0, 51310, 56620, 59F90.
  228.  
  229.  
  230. · RAD
  231.  
  232.    This format came with Reality ADlib Tracker. Tunes often have  RAD extension
  233. and if not, there is a 'RAD' sign at the beginning of the file.
  234.  
  235.  
  236. · RAW
  237.  
  238.    This format is very simple. It  consists  of  commands  directly sent to OPL
  239. port. RAW format is used in STARPRT2.EXE intro (for example).
  240.    format:   [0]=db     'RAWADATA'                 ... file identifier
  241.              [8]=dw     clock                      ... clock (int8) speed
  242.             [10]=dw     data_size dup (data)       ... adlib data
  243.             [..]=dw     0ffffh                     ... end of file
  244.    data: parameter, command.   command==0: data==n ... wait n times.
  245.                                command==2: data==0 ... set speed (next word)
  246.                                command==2: data==1 ... set OPL3 port A default
  247.                                command==2: data==2 ... set OPL3 port B default
  248.  
  249.    This format is also generated by RAC (Rdos Adlib Catcher).
  250.  
  251.  
  252. · SAT
  253.  
  254.    These  files are made in SAdT music composer. They begin with 'SAdT' sign.
  255.  
  256.  
  257. · SDB, AGD
  258.  
  259.    These files are used in DUNE game. Look  in  game's directory and search for
  260. *.SDB  or  *.AGD  files.  These  are  HSQ-packed.  You  can  unpack  them  with
  261. UNHSQ (RDOS production)  or  use  them  as  they are. RdosPlay has internal HSQ
  262. unpacker and recognizes both packed or unpacked modules. *.AGD files have to be
  263. played on OPL-3  stereo  music  chip (that's why /s parameter doesn't work with
  264. them), *.SDB are for standard AdLib (OPL-2) card.
  265.  
  266.  
  267. · SIG
  268.  
  269.    These  files  are used in DIZZY games. They are stored in main .EXE file and
  270. you have to grab them. Here are  their respective filenames, offsets and sizes:
  271.   FFOOD=6464E,3B38  KWIKSNAX=73C2E,2BC4  MAGICLND=689EE,4508  YOLK=6571E,33FD
  272.  
  273.  
  274. · VIB
  275.  
  276.    This is standard used in player by JO / Vibrants.
  277.    Example: intro COPPER.EXE, offset 8990.
  278.  
  279.  
  280. RDOSPLAY FREQUENTLY ASKED QUESTIONS:
  281. ------------------------------------
  282.  
  283. * RdosPlay have not detected my soundcard although I have OPL2 compatible card.
  284. - You have to set sound card manually (ie. /p parameter).
  285. - GUS users with SBOS running may use /p388:1.
  286.  
  287. * RdosPlay sounds HORRIBLE on GUS !
  288. - That's the fault of OPL2 emulation on GUS, not mine. You have to stay with it
  289.   or to wait until REMUS (Rdos Emulation Sound system) is released. It will
  290.   bring a brand new OPL3 emulation for your GUS (hopefully).
  291.  
  292. * I have D/A converter (PC Speaker), does RdosPlay support it ?
  293. - No, It does not. You have to wait until REMUS is released.
  294.  
  295. * I have some SAT modules and it seems some of them aren't played correctly
  296.   with RdosPlay.
  297. - Yes, it's the fault of RdosPlay's SAT playing routine. I have to improve it.
  298.  
  299. * What about a fileselector in RdosPlay ?
  300. - It's currently in development, wait for new RdosPlay release.
  301.  
  302. * Why are sometimes FXM modules played incorrectly (i mean drums) ?
  303. - Not 100% right FXM interpreter initialization causes that noise channel of
  304.   adlib card is not initialized at all. FXM player is undergoing recontruction
  305.   now. Wait for another release.
  306.  
  307.  
  308. WHERE TO FIND RDOSPLAY:
  309. -----------------------
  310. Each time I have a new version of RDOSPLAY available, I'll upload it to
  311. this place:
  312.  
  313.  ftp://sorry.vse.cz/dimension   (Dimension FTP site in Prague, Czech Republic)
  314. http://sorry.vse.cz/dimension   (Dimension Inet HeadQuarters, Czech Republic)
  315.  
  316. RdosPlay will be probably also available at ftp.cdrom.com and ftp.sunet.se
  317. FTP archives.
  318.  
  319.    Ask your local Internet or FTP expert on how to reach them.
  320.  
  321. Another way is to visit RdosPlay's homepage at address:
  322.  
  323.    http://sorry.vse.cz/dimension/rdos/rdosplay   (Http site in Prague, CZE)
  324.  
  325.  
  326. THANX:
  327. ------
  328.  
  329. Although I did all the programming, there are few friends which helped me with
  330. some things about this program. Thanx go to:
  331.  
  332. Ondrej Stasek (Ondar/Dimension) - testing, suggestions, new formats delivery
  333. David Voracek (Assassin/Dimension) -          - || -
  334.  
  335. and other friends for their (mostly) betatesting and suggestions..
  336.  
  337.  
  338. CONTACTING ME:
  339. --------------
  340.   If you want to contact me, write to address listed below. If you want to send
  341. me suggestions, tips or simply greets, send it freely. Also some money would be
  342. good as a power and motivation for further work :-)  If you find any new module
  343. format  with  its  player  you can also send it to me. You can also send me any
  344. module you want to be in new version of RdosPlay.
  345.  
  346. My address:                           E-Mail: (non-commercial)
  347.   Roman Dolejsi (RDOS)                    roman@sorry.vse.cz
  348.   Husova 419, Vcelna                      roman@romeo.pf.jcu.cz
  349.   37382 Ceske Budejovice
  350.   Czech Republic
  351.  
  352. Please do not send me E-mails longer than 150kB (because of our local smtp
  353. server limit).
  354.  
  355. *** end of RDOSPLAY documentation ***